Implementing Campaign Manager - External Integrations


Execute Document Plugin Options

There are a number of settings used to control how the plugin works.

Step Name

The name of the transformation step, the name must be unique in a single transformation.

Server Location

Enter the name of the server location in a URL format. This parameter can be provided in a variable specification format ${Name_Of_Variable}

Token

Provide token in the form of aabbcc-ffgg-eegg-hhdd. A valid user session CMTokenInformation must be provided. This token must have read\write permissions for the document.

IgnoreLock check box

When a user opens a document, it is locked out by that user. Selecting this check box ignores that lock and allows the system to process the document. Typically you would not select this field unless you have issues with users leaving documents open.

Note:

Known behavior - If Ignore Lock is selected, and the document is currently open, when executed, an error is returned similar to the following:

2017/03/13 17:24:09 - Execute Documents.0 - Failed to execute document id - 45: StatusCode=DocumentLocked

2017/03/13 17:24:09 - Execute Documents.0 - WARNING - Doc found, but could not execute it. Doc # 45

To avoid this behavior, the following workaround is recommended:

Untick the Ignore Lock checkbox

Save the transformation

Tick the Ignore Lock checkbox

Save the transformation

SaveResults

Select this check box to save the results of the execute. If you are executing an engineering document, you can safely [and should] ignore. If you are executing a dashboard, chart, segment, etc. select the check box so that the results of the run are saved for the next time you open the document.

Select document id column

A drop-down list of columns provided in input step, data grid in this example. Document id's and document name are the columns in the data grid step.

Status-field name

An optional field that allows you to set the name of the status column. This field can be used to access the plugin status. If left blank the value will default to 'Status'.

  Online & Instructor-Led Courses | Training Videos | Webinar Recordings
© Alterian. All Rights Reserved. | Privacy Policy | Legal Notice